Skip to main content

Suspend-IMJob

SYNOPSIS​

Suspends Immich background jobs

SYNTAX​

Suspend-IMJob [[-Session] <ImmichSession>] [-Job] <String[]> [-Force] [-ProgressAction <ActionPreference>]
 [<CommonParameters>]

DESCRIPTION​

Temporarily suspends processing of specific job types in Immich. Suspended jobs will not process new items but existing running jobs may continue. Use Resume-IMJob to restart processing.

EXAMPLES​

EXAMPLE 1​

Suspend-IMJob -Job 'thumbnailGeneration'

Suspends thumbnail generation processing.

EXAMPLE 2​

Suspend-IMJob -Job 'videoConversion' -Force

Forcibly suspends video conversion jobs.

EXAMPLE 3​

@('faceDetection', 'duplicateDetection') | ForEach-Object { Suspend-IMJob -Job $_ }

Suspends multiple job types.

PARAMETERS​

-Session​

Optionally define an Immich session object to use. This is useful when you are connected to more than one Immich instance.

Type: ImmichSession
Parameter Sets: (All)
Aliases:

Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Job​

The type of job to suspend. Valid values include thumbnailGeneration, metadataExtraction, videoConversion, faceDetection, and other background job types.

Type: String[]
Parameter Sets: (All)
Aliases:

Required: True
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Force​

Forces the suspension without additional confirmation.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-ProgressAction​

{{ Fill ProgressAction Description }}

Type: ActionPreference
Parameter Sets: (All)
Aliases: proga

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters​

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS​

OUTPUTS​

NOTES​

Suspended jobs can be resumed using Resume-IMJob. Use Get-IMJob to monitor job queue status. Suspending jobs is useful during maintenance windows or when system resources are needed elsewhere.

EDIT THIS DOC​

This page was auto-generated from the powershell command comment based help. To edit the content of this page, update the script file comment based help on github Github